v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

columns

Update column

Updates properties of the column, moves the column, or renames the column.

Important:

You cannot change the type of a Primary Column.

If you change the type, all cells in the column are converted to the new column type, and column validation is cleared.

The type property is optional when moving or renaming a column, but it's required when changing symbol, systemColumnType, options, contactOptions, or autoNumberFormat.

When setting a column type of PICKLIST or MULTI_PICKLIST, you must follow a one update per API call rule. For these column types, you must set the column type first, before making any additional constraints (such as setting validation to true) in subsequent calls.

Column options are forbidden in the request body when the body specifies a symbol update.

While dependencies are enabled on a sheet, you can't change the type of any calendar column, Gantt column, or Resource Management column. Such columns have a tags array that contains at least one of the following enum values:

CALENDAR_END_DATE

CALENDAR_START_DATE

CARD_DONE

GANTT_ALLOCATION

GANTT_ASSIGNED_RESOURCE

GANTT_DISPLAY_LABEL

GANTT_DURATION

GANTT_END_DATE

GANTT_PERCENT_COMPLETE

GANTT_PREDECESSOR

GANTT_START_DATE

BASELINE_START_DATE

BASELINE_END_DATE

BASELINE_VARIANCE

put/sheets/{sheetId}/columns/{columnId}

Request body

Example request

{
  "id": 4567890123,
  "width": 150,
  "tags": []
}

Response

Returns Result object containing the Column object that was modified.

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": {
    "id": 4567890123,
    "width": 150,
    "tags": []
  }
}