---
title: "Set dashboard publish status"
method: PUT
path: "/sights/{sightId}/publish"
tags: ["dashboards"]
---

# Set dashboard publish status

`PUT /sights/{sightId}/publish`

Publishes or unpublishes a dashboard.

## Headers

- `Content-Type` string

## Request body

- SightPublish — Describes the dashboard's publish settings.
  - `readOnlyFullAccessibleBy` 'ALL' | 'ORG' — Indicates who can access the 'Read-Only Full' view of the published dashboard. Only returned in the response if **readOnlyFullEnabled = true**. * **ALL** - available to anyone who has the link. * **ORG** - available only to members of the dashboard owner's Smartsheet organization account. * **SHARED** - available only to users shared to the item. --- If **readOnlyFullEnabled** is set to true in the request, but **readOnlyFullAccessibleBy** is not specified, the value of **readOnlyFullAccessibleBy** defaults to the organization-level 'Dashboard Publishing' setting (if the dashboard owner belongs to an organization account) or to **ALL** (if the dashboard owner does not belong to an organization account).
  - `readOnlyFullEnabled` boolean, required — If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.
  - `readOnlyFullUrl` string — URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true.

## Response `200`

SightPublish object

- object
  - `message` 'PARTIAL_SUCCESS' | 'SUCCESS' — Message that indicates the outcome of the request. (One of `SUCCESS` or `PARTIAL_SUCCESS`.)
  - `resultCode` 0 | 3 — * '0' Success * '3' Partial Success of Bulk Operation
  - `failedItems` BulkItemFailure[], nullable — Array of BulkItemFailure objects which represents the items that failed to be added or updated. See [Bulk operations > Partial success](/api/smartsheet/guides/advanced-topics/scalability-options) for more information. Applicable only for bulk operations that support partial success.
    - `rowId` number, nullable — The ID of the row that failed. Applicable only to bulk row operations.
    - `error` Error — The error caused by the failed item.
      - `refId` string — The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.
      - `errorCode` number — Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).
      - `message` string — Descriptive error message.
    - `index` number — The index of the failed item in the bulk request array.
  - `result` SightPublish — Describes the dashboard's publish settings.
    - `readOnlyFullAccessibleBy` 'ALL' | 'ORG' — Indicates who can access the 'Read-Only Full' view of the published dashboard. Only returned in the response if **readOnlyFullEnabled = true**. * **ALL** - available to anyone who has the link. * **ORG** - available only to members of the dashboard owner's Smartsheet organization account. * **SHARED** - available only to users shared to the item. --- If **readOnlyFullEnabled** is set to true in the request, but **readOnlyFullAccessibleBy** is not specified, the value of **readOnlyFullAccessibleBy** defaults to the organization-level 'Dashboard Publishing' setting (if the dashboard owner belongs to an organization account) or to **ALL** (if the dashboard owner does not belong to an organization account).
    - `readOnlyFullEnabled` boolean, required — If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.
    - `readOnlyFullUrl` string — URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true.

## Other responses

- `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)
