Reserved: Sets the shared access information for users
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 functionality.
Related topics
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Query Parameters
Specifies the type of shared item being set:
envelopes: Set envelope sharing between users.templates: Set information about template sharing among users and groups.folders: Get information about folder sharing among users and groups.
A comma-separated list of IDs for users whose shared item access is being set.
Request Body
application/json
Contains shared access information.
The account ID associated with the envelope.
The last index position in the result set.
This object describes errors that occur. It is only valid for responses and ignored in requests.
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.
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.
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.
A list of shared access information of envelope and templates for the users specified in the request.
The starting index position of the current result set.
The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/shared_access" \ -H "Content-Type: application/json" \ -d '{}'{ "accountId": "string", "endPosition": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "sharedAccess": [ { "envelopes": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "shared": "string", "user": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } } ], "errorDetails": { "errorCode": "string", "message": "string" }, "folders": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "folderId": "string", "name": "string", "owner": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" }, "parentFolderId": "string", "parentFolderUri": "string", "shared": "string", "sharedGroups": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "group": { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" }, "shared": "string" } ], "sharedUsers": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "shared": "string", "user": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } } ], "uri": "string", "user": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } } ], "templates": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "owner": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" }, "password": "string", "shared": "string", "sharedGroups": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "group": { "accessType": "string", "dsGroupId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "groupId": "string", "groupName": "string", "groupType": "string", "isManagedByScim": true, "lastModifiedOn": "string", "permissionProfileId": "string", "userGroupType": "string", "users": [ { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } ], "usersCount": "string" }, "shared": "string" } ], "sharedUsers": [ { "errorDetails": { "errorCode": "string", "message": "string" }, "shared": "string", "user": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } } ], "templateId": "string", "templateName": "string" } ], "user": { "accountId": "string", "accountName": "string", "activationAccessCode": "string", "email": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "ipAddress": "string", "loginStatus": "string", "membershipId": "string", "sendActivationEmail": "string", "uri": "string", "userId": "string", "userName": "string", "userStatus": "string", "userType": "string" } } ], "startPosition": "string", "totalSetSize": "string"}Reserved: Gets the shared item status for one or more users GET
Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`. **Note:** This endpoint returns the shared status for the legacy Shared Envelopes feature. To use the new Shared Access feature, use the [Authorizations resource](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/authorizations/). ### Related topics - [How to share access to a Docusign envelope inbox](https://developers.docusign.com/docs/esign-rest-api/how-to/shared-access/)
Gets the supported languages for envelope recipients GET
Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=wxf1578456494201.html).