Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
Accounts

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

  • How to share access to a Docusign envelope inbox
put/v2.1/accounts/{accountId}/shared_access

Path parameters

accountIdstring required

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

Query parameters

item_typestring

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.
preserve_existing_shared_accessstring

When true, preserve the existing shared access settings.

user_idsstring

A comma-separated list of IDs for users whose shared item access is being set.

Request body

accountIdstring

The account ID associated with the envelope.

endPositionstring

The last index position in the result set.

nextUristring

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.

previousUristring

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.

resultSetSizestring

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.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

Response

Successful response.