---
title: "Share asset"
method: POST
path: "/shares"
tags: ["sharing"]
---

# Share asset

`POST /shares`

Shares an asset with the specified users and/or groups.

**One (and only one) of the following is required (alongside accessLevel)**:
  - email
  - groupId

## Query parameters

- `assetType` 'sheet' | 'report' | 'sight' | 'workspace' | 'collection' | 'file', required
- `assetId` string, required
- `sendEmail` boolean

## Request body

- CreateShareRequest[]
  - `email` string — The primary email address of a user to share to. Must be provided if `groupId` is not provided.
  - `groupId` number — The ID of the group to share to. Must be provided if `email` is not provided.
  - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER', required
  - `subject` string — The subject of the email that is optionally sent to notify the recipient. Must set the `sendEmail` query parameter to **true** for this parameter to take effect.
  - `message` string — The message included in the body of the email that is optionally sent to the recipient. Must set the `sendEmail` query parameter to **true** for this parameter to take effect.
  - `ccMe` boolean — Indicates whether to send a copy of the email to the sharer of the sheet. Must set the `sendEmail` query parameter to **true** for this parameter to take effect.

## Response `200`

Result object containing an array of [Share response](/api/smartsheet/openapi/sharing/shareresponse) objects, corresponding to what was specified in the request.

If the users and/or groups are already shared to the specified asset, they will be omitted from the response. 
An empty response indicates that all the users and/or groups in the request are already shared to the asset.

- object
  - `message` 'SUCCESS' — Message that indicates the request was successful.
  - `resultCode` 0 — * '0' Success
  - `result` ShareResponse[]
    - `id` string, required — The ID of the share.
    - `email` string — User's primary email address for user shares.
    - `userId` number — User ID if the share is a user share.
    - `groupId` number — Group ID if the share is a group share.
    - `name` string — If present, the name of the user or group to which the asset is shared.
    - `type` string, 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).

## Other responses

- `400` — 4XX errors typically indicate client input validation failures.
- `default` — Generic Error Payload

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)