SMsmartsheet
sheets

Set sheet publish status

Sets the publish status of the sheet and returns the new status, including the URLs of any enabled publishings.

put/sheets/{sheetId}/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

readOnlyFullAccessibleBy'ALL' | 'ORG' | 'SHARED'

Indicates who can access the 'Read-Only Full' view of the published sheet:

  • ALL - available to anyone who has the link.
  • ORG - available only to members of the sheet owner's Smartsheet organization account.
  • SHARED - available only to users shared to the item.

Only returned in the response if readOnlyFullEnabled = true.

readOnlyFullDefaultView'CALENDAR' | 'CARD' | 'GRID'

Indicates which view the user has set for a read-only, default view of the published sheet. Must be one of the listed enum values.

readOnlyFullEnabledboolean

If true, a rich version of the sheet is published with the ability to download row attachments and discussions.

readOnlyFullShowToolbarboolean

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

readOnlyLiteEnabledboolean

If true, a lightweight version of the sheet is published without row attachments and discussions.

readWriteAccessibleBy'ALL' | 'ORG' | 'SHARED'

Indicates who can access the 'Edit by Anyone' view of the published sheet:

  • ALL - available to anyone who has the link.
  • ORG - available only to members of the sheet owner's Smartsheet organization account.
  • SHARED - available only to users shared to the item.

Only returned in the response if readWriteEnabled = true.

readWriteDefaultView'CALENDAR' | 'CARD' | 'GRID'

Indicates which view the user has set for a read-write, default view of the published sheet. Must be one of the listed enum values.

readWriteEnabledboolean

If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions.

readWriteShowToolbarboolean

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

Response

OK

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.