# Set dashboard publish status

Publishes or unpublishes a dashboard.

Endpoint: PUT /sights/{sightId}/publish
Version: 2.0.0
Security: APIToken, OAuth2

## Header parameters:

  - `Authorization` (string)
    API Access Token used to authenticate requests to Smartsheet APIs.

  - `smartsheet-integration-source` (string)
    Uses the following metadata to distinguish between human-initiated API requests and third-party service-initiated calls by AI Connectors or ITSM:

- Integration source type
- Organization name
- Integration source name 

Format:


TYPE,OrgName,SourceName


Examples: 

AI,SampleOrg,My-AI-Connector-v2

SCRIPT,SampleOrg2,Accounting-updater-script

APPLICATION,SampleOrg3,SheetUpdater
    Example: "AI,SampleOrg,My-AI-Connector-v2"

  - `Content-Type` (string)
    Required for POST and PUT requests. Defines the structure for the request body.

## Path parameters:

  - `sightId` (string, required)
    ID of the dashboard (sight) being accessed.

## Request fields (application/json):

  - `readOnlyFullAccessibleBy` (string)
    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).
    Enum: "ALL", "ORG"

  - `readOnlyFullEnabled` (boolean, required)
    If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.

## Response 200 fields (application/json):

  - `failedItems` (array,null)
    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.

  - `failedItems.rowId` (number,null)
    The ID of the row that failed. Applicable only to bulk row operations.

  - `failedItems.error` (object)
    The error caused by the failed item.

  - `failedItems.error.refId` (string)
    The ID of the specific error occurrence. Please include this information when contacting Smartsheet support.

  - `failedItems.error.errorCode` (number)
    Custom error code from Smartsheet. See the complete [Error Code List](/api/smartsheet/error-codes).

  - `failedItems.error.message` (string)
    Descriptive error message.

  - `failedItems.index` (number)
    The index of the failed item in the bulk request array.

  - `message` (string)
    Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)
    Enum: "PARTIAL_SUCCESS", "SUCCESS"

  - `resultCode` (number)
    * '0' Success
* '3' Partial Success of Bulk Operation
    Enum: 0, 3

  - `result` (object)
    Describes the dashboard's publish settings.

  - `result.readOnlyFullAccessibleBy` (string)
    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).
    Enum: "ALL", "ORG"

  - `result.readOnlyFullEnabled` (boolean, required)
    If true, a rich version of the dashboard is published with the ability to use shortcuts and widget interactions.

  - `result.readOnlyFullUrl` (string)
    URL for 'Read-Only Full' view of the published dashboard. Only returned in a response if readOnlyFullEnabled = true.

## Response default fields (application/json):

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