SMsmartsheet
reports

Set a report's publish status

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

put/reports/{reportId}/publish

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_SHEETS

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Request body

readOnlyFullAccessibleBystring

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.

readOnlyFullDefaultViewstring

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.

readOnlyFullEnabledboolean

(Required) If true, a rich version of the report is published with the ability to download row attachments and discussions.

readOnlyFullShowToolbarboolean

Deprecated Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar.

If false, hides the toolbar.

readOnlyFullUrlstring

URL for 'Read-Only Full' view of the published report.

Only returned in a response if readOnlyFullEnabled = true.

Response

ReportPublish object

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.