PUT /sheets/{sheetId}/publish
Sets the publish status of the sheet and returns the new status, including the URLs of any enabled publishings.
Servers
- https://api.smartsheet.com/2.0
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
readOnlyFullEnabled |
Boolean | No |
If true, a rich version of the sheet is published with the ability to download row attachments and discussions. |
readWriteAccessibleBy |
String | No |
Indicates who can access the 'Edit by Anyone' view of the published sheet:
Only returned in the response if readWriteEnabled = true. Possible values:
|
readOnlyFullDefaultView |
String | No |
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. Possible values:
|
readWriteShowToolbar |
Boolean | No |
Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar. |
readOnlyFullShowToolbar |
Boolean | No |
Indicates whether the left nav toolbar is displayed. The default, or true, is to display the toolbar. If false, hides the toolbar. |
icalEnabled |
Boolean | No |
If true, a webcal is available for the calendar in the sheet. |
readWriteEnabled |
Boolean | No |
If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions. |
readOnlyFullAccessibleBy |
String | No |
Indicates who can access the 'Read-Only Full' view of the published sheet:
Only returned in the response if readOnlyFullEnabled = true. Possible values:
|
readOnlyLiteEnabled |
Boolean | No |
If true, a lightweight version of the sheet is published without row attachments and discussions. |
readWriteDefaultView |
String | No |
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. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.