---
title: "Set a report's publish status"
method: PUT
path: "/reports/{reportId}/publish"
tags: ["reports"]
---

# Set a report's publish status

`PUT /reports/{reportId}/publish`

Sets the publish status of the report and returns the new status, including the URL of any enabled publishing.

## Headers

- `Content-Type` string

## Request body

- ReportPublish
  - `readOnlyFullAccessibleBy` string — Indicates who can access the 'Read-Only Full' view of the published report: * If **ALL**, it is available to anyone who has the link. * If **ORG**, it is available only to members of the report owner's Smartsheet organization account. * If **SHARED**, it is available only to users shared to the item. Only returned in a response if **readOnlyFullEnabled** = **true**.
  - `readOnlyFullDefaultView` string — Indicates which view the user has set for a read-only, default view of the published report. Must be one of the following values: **CALENDAR**, **CARD**, or **GRID**.
  - `readOnlyFullEnabled` boolean — (Required) If **true**, a rich version of the report is published with the ability to download row attachments and discussions.
  - `readOnlyFullShowToolbar` boolean — **Deprecated** Indicates whether the left nav toolbar is displayed. The default, or **true**, is to display the toolbar. If **false**, hides the toolbar.
  - `readOnlyFullUrl` string — URL for 'Read-Only Full' view of the published report. Only returned in a response if **readOnlyFullEnabled** = **true**.

## Response `200`

ReportPublish 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` ReportPublish
    - `readOnlyFullAccessibleBy` string — Indicates who can access the 'Read-Only Full' view of the published report: * If **ALL**, it is available to anyone who has the link. * If **ORG**, it is available only to members of the report owner's Smartsheet organization account. * If **SHARED**, it is available only to users shared to the item. Only returned in a response if **readOnlyFullEnabled** = **true**.
    - `readOnlyFullDefaultView` string — Indicates which view the user has set for a read-only, default view of the published report. Must be one of the following values: **CALENDAR**, **CARD**, or **GRID**.
    - `readOnlyFullEnabled` boolean — (Required) If **true**, a rich version of the report is published with the ability to download row attachments and discussions.
    - `readOnlyFullShowToolbar` boolean — **Deprecated** Indicates whether the left nav toolbar is displayed. The default, or **true**, is to display the toolbar. If **false**, hides the toolbar.
    - `readOnlyFullUrl` string — URL for 'Read-Only Full' view of the published report. 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)