SMsmartsheet
reports

Update report column

Updates the specified column in the report.

put/reports/{reportId}/columns/{columnVirtualId}

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

Request body

titlestring

Title of a column.

indexinteger

Column index or position. This number is zero-based. Indicates the position of the column in the generated report.

hiddenboolean

Indicates whether the column is hidden.

widthinteger

Display width of the column in pixels.

Response

Returns Result object containing the updated Report column 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",
  "result": {
    "type": "PICKLIST",
    "systemColumnType": "CREATED_BY",
    "autoNumberFormat": {
      "fill": "",
      "prefix": "",
      "startingNumber": 1,
      "suffix": ""
    }
  }
}

Changes

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