Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
sharing

Update asset share

Updates the share for a specified asset.

Note: This operation doesn't support asset ownership transfer.

patch/shares/{shareId}

Path parameters

shareIdstring required

The unique identifier for the share.

Query parameters

assetType'sheet' | 'report' | 'sight' | 'workspace' | 'collection' | 'file' required
Example:sheet

The type of the asset. Used in combination with assetId to determine the asset.

assetIdstring required
Example:1234567890

The ID of the asset being accessed. It's used in combination with assetType to determine the asset.

Depending on the asset, this may be a numeric or string value.

Request body

accessLevel'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'VIEWER' required

Response

Result object containing a Share response object, corresponding to what was specified in the request.

idstring required

The ID of the share.

emailstring

User's primary email address for user shares.

userIdnumber

User ID if the share is a user share.

groupIdnumber

Group ID if the share is a group share.

namestring

If present, the name of the user or group to which the asset is shared.

typestring required

The type of this share. One of the following values: GROUP or USER.

accessLevel'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' required
scope'ITEM' | 'WORKSPACE' required

The scope of this share. One of the following values:

  • ITEM: an item-level share (that is, the specific object to which the share applies is shared with the user or group).
  • WORKSPACE: a workspace-level share (that is, the workspace that contains the asset to which the share applies is shared with the user or group).

Example response

{
  "id": "AAAMCmYGFOeE",
  "email": "test.email@smartsheet.com",
  "userId": 9876543210,
  "groupId": 1234567890,
  "name": "Example Name",
  "type": "USER"
}