--- title: "Add image to cell" method: POST path: "/sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages" tags: ["cellImages"] --- # Add image to cell `POST /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages` Uploads an image to the specified cell within a sheet. ## Query parameters - `altText` string - `overrideValidation` boolean ## Headers - `Content-Type` string - `Content-Disposition` string - `Content-Length` integer ## Response `200` SUCCESS - object - `message` 'PARTIAL_SUCCESS' | 'SUCCESS' — Message that indicates the outcome of the request. (One of `SUCCESS` or `PARTIAL_SUCCESS`.) - `resultCode` 0 | 3 — * '0' Success * '3' Partial Success of Bulk Operation - `failedItems` BulkItemFailure[], nullable — 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. - `rowId` number, nullable — The ID of the row that failed. Applicable only to bulk row operations. - `error` Error — The error caused by the failed item. - `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. - `index` number — The index of the failed item in the bulk request array. - `version` number, nullable — New version of the sheet. Applicable only for operations which update sheet data. - `result` Row - `id` number — Row ID. - `siblingId` number — Sibling ID. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `attachments` Attachment[] — Attachments on row. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `cells` Cell[] — Cells belonging to the row. - `columnId` number — The ID of the column that the cell is located in. - `columnType` string — Only returned if the include query string parameter contains **columnType**. - `conditionalFormat` string — The format descriptor describing this cell's conditional format. Only returned if the include query string parameter contains **format** and this cell has a conditional format applied. - `displayValue` string — Visual representation of cell contents, as presented to the user in the UI. - `format` string — The format descriptor. Only returned if the include query string parameter contains **format** and this cell has a non-default format applied. - `formula` string — The formula for a cell, if set, for instance **=COUNTM([Assigned To]3)**. Note that calculation errors or problems with a formula do not cause the API call to return an error code. Instead, the response contains the same value as in the UI, such as **cell.value = "#CIRCULAR REFERENCE"**. - `hyperlink` Hyperlink - `reportId` number — If non-null, this hyperlink is a link to the report with this ID. - `sheetId` number — If non-null, this hyperlink is a link to the sheet with this ID. - `sightId` number — If non-null, this hyperlink is a link to the dashboard with this ID. - `url` string — When the hyperlink is a URL link, this property contains the URL value. When the hyperlink is a dashboard/report/sheet link (that is, dashboardId, reportId, or sheetId is non-null), this property contains the permalink to the dashboard, report, or sheet. - `image` Image - `altText` string — Alternate text for the image. - `height` number — Original height (in pixels) of the uploaded image. - `id` string — Image ID. - `width` number — Original width (in pixels) of the uploaded image. - `linkInFromCell` CellLink - `columnId` number — Column ID of the linked cell. - `rowId` number — Row ID of the linked cell. - `sheetId` number — Sheet ID of the sheet that the linked cell belongs to. - `sheetName` string — Sheet name of the linked cell. - `status` 'BLOCKED' | 'BROKEN' | 'CIRCULAR' | 'DISABLED' | 'INACCESSIBLE' | 'INVALID' | 'NOT_SHARED' | 'OK' — * `BLOCKED` One of several other values indicating unusual error conditions. * `BROKEN` The row or sheet linked to was deleted. * `CIRCULAR` One of several other values indicating unusual error conditions. * `DISABLED` One of several other values indicating unusual error conditions. * `INACCESSIBLE` The sheet linked to cannot be viewed by this user. * `INVALID` One of several other values indicating unusual error conditions. * `NOT_SHARED` One of several other values indicating unusual error conditions. * `OK` The link is in a good state. - `linksOutToCells` CellLink[] - `columnId` number — Column ID of the linked cell. - `rowId` number — Row ID of the linked cell. - `sheetId` number — Sheet ID of the sheet that the linked cell belongs to. - `sheetName` string — Sheet name of the linked cell. - `status` 'BLOCKED' | 'BROKEN' | 'CIRCULAR' | 'DISABLED' | 'INACCESSIBLE' | 'INVALID' | 'NOT_SHARED' | 'OK' — * `BLOCKED` One of several other values indicating unusual error conditions. * `BROKEN` The row or sheet linked to was deleted. * `CIRCULAR` One of several other values indicating unusual error conditions. * `DISABLED` One of several other values indicating unusual error conditions. * `INACCESSIBLE` The sheet linked to cannot be viewed by this user. * `INVALID` One of several other values indicating unusual error conditions. * `NOT_SHARED` One of several other values indicating unusual error conditions. * `OK` The link is in a good state. - `objectValue` union - string - number - boolean - AbstractDatetimeObjectValue — Object representing a calculated datetime - `objectType` 'ABSTRACT_DATETIME' - `value` string, date-time — Datetime, in the **date-time** format defined by RFC 3339, section 5.6 - ContactObjectValue — Object containing a Contact - `objectType` 'CONTACT' - `email` string, email — Email address of the Contact - `name` string — Name of the Contact - `imageId` string — ID of an image associated with the Contact - `emailId` string — ID of the email address - `userId` string — User ID of the contact - `lookUpName` boolean — Whether or not to look up the contact's name based on their email address. - DateObjectValue — Object representing a date - `objectType` 'DATE' - `value` string, date — Date in the **full-date** format defined by RFC 3339, section 5.6 - DatetimeObjectValue — Object representing a datetime - `objectType` 'DATETIME' - `value` string, date-time — Datetime, in the **date-time** format defined by RFC 3339, section 5.6 - DurationObjectValue — Object representing a duration in days - `objectType` 'DURATION' - `days` number, float — Number of days - MultiContactObjectValue — Object containing a list of contacts - `objectType` 'MULTI_CONTACT' - `value` ContactObjectValue[] — List of Contacts - `objectType` 'CONTACT' - `email` string, email — Email address of the Contact - `name` string — Name of the Contact - `imageId` string — ID of an image associated with the Contact - `emailId` string — ID of the email address - `userId` string — User ID of the contact - `lookUpName` boolean — Whether or not to look up the contact's name based on their email address. - MultiPicklistObjectValue — Object containing a list of strings to choose from - `objectType` 'MULTI_PICKLIST' - `values` string[] — List of strings to choose from - PredecessorList — Object containing a list of references to rows on which the current row depends - `objectType` 'PREDECESSOR_LIST' - `predecessors` Predecessor[] — List of references to rows on which the current row depends - `rowId` number — The ID of the predecessor row. - `type` 'FF' | 'FS' | 'SF' | 'SS' — Type of the predecessor: * FF (Finish-to-Finish) - finish at the same time the predecessor finishes. * FS (Finish-to-Start) - start after the predecessor finishes. * SF (Start-to-Finish) - finish before the predecessor starts. * SS (Start-to-Start) - start at the same time the predecessor starts. - `inCriticalPath` boolean — True if this predecessor is in the critical path. - `invalid` boolean — True if the row referenced by rowId is not a valid row in this sheet, or there is a circular reference (displayed in the Smartsheet app as "#REF") Omitted if false. - `lag` Duration — In a project sheet, represents a value in a duration cell, or a lag value of a predecessor. - … - `rowNumber` number — The row number of the predecessor row. Omitted if invalid is true. - `overrideValidation` boolean — (Admin only) Indicates whether the cell value can contain a value outside of the validation limits (value = **true**). When using this parameter, you must also set **strict** to **false** to bypass value type checking. This property is honored for POST or PUT actions that update rows. - `strict` boolean — Set to **false** to enable lenient parsing. Defaults to **true**. You can specify this attribute in a request, but it is never present in a response. - `value` union — A string, number, or a Boolean value -- depending on the cell type and the data in the cell. Cell values larger than 4000 characters are silently truncated. An empty cell returns no value. - string - number - boolean - `columns` Column[] — Columns of row. Only returned if the include query string parameter contains columns. - union - object — A column of numeric values or text. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =[Column A]@row + [Column B]@row - `primary` boolean — If set to `true`, the column is the sheet's Primary Column. This property is returned only if the property is set to `true`. - `tags` string[] — This property is only present for *dependency-enabled project sheets.* For details on Gantt view, refer to Create and work with a Gantt view. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of auto-generated numbers. > **Note:** A sheet can have at most one auto number column. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `autoNumberFormat` AutoNumberFormat, required — Specifies how to format values for an auto-generated numbers column. - `fill` string — Indicates zero-padding. It must be between 0 and 10 "0" (zero) characters. - `prefix` string — The prefix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `startingNumber` number — The starting number for the auto-ID. - `suffix` string — The suffix. Can include these date tokens: * {DD} * {MM} * {YY} * {YYYY} - `systemColumnType` 'AUTO_NUMBER', required — If this property is set, the column contains auto-generated numbers. Its [Auto-number format object](/api/smartsheet/openapi/schemas/autonumberformat) describes the mask used to generate column values. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of checkboxes that you can select or clear. You can display the column checkboxes as one of the following symbols: - box - flag - star - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: "=ISODD([ID]@row)" - `symbol` 'FLAG' | 'STAR' — A checkbox column can use box (default), flag, or star symbols. See [Symbol Columns](/api/smartsheet/openapi/columns). If the box symbol is used, the `symbol` property is absent. - `tags` string[] — If present, `true` cell values indicate completed tasks. This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'CHECKBOX', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined contacts from which you can choose up to one for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `contactOptions` ContactOption[] — Array of ContactOption objects to specify a pre-defined list of values for the column. - `email` string — A parsable email address. - `name` string — Can be a user's name, display name, or free text. - `formula` string — The formula for the column, if set. For example: =IF(Department@row = "Engineering", "jane.doe@company.com", IF(Department@row = "Marketing", "john.smith@company.com", "admin@company.com")) - `type` 'CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column that identifies the user who created each row. > **Note:** A sheet has at most, one of these columns. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'CREATED_BY', required — The contact represents the user who created the row. - `type` 'CONTACT_LIST', required - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column of datetime values representing each row's creation datetime. > **Note:** This type of column can only be added via the web application, and a sheet can only have one column of this type. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'CREATED_DATE', required — The system row creation datetime type. - `type` 'DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of datetime values. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =TODAY(-1) - `type` 'DATE', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — Column for datetime values in dependency-enabled project sheets. > **Important:** For the column to represent Gantt or baseline start/end dates, the project sheet must have dependencies enabled. Workload tracking requires connection to the Resource Management product. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. > > For details on baselines, refer to Set baselines on a sheet. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — The formula for the column, if set. For example: =TODAY(-1) - `tags` string[] — This property is only present for dependency-enabled project sheets. It indicates what the date represents in terms of the dependency-enabled project. - `type` 'ABSTRACT_DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined values from which you can choose for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches one of the symbol options exactly (for example, "Red", "Yellow", "Green"). For example: =[Literal Rating]@row - `options` string[], required — An array of the options available to use in the column. - `type` 'PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — Cell values in a duration column represent the amount of working time between the current row's start time and its end time. > **Important:** The API doesn't support creating duration columns-you can only create them in the web application. > > Note, duration columns are for *dependency-enabled project sheets only*. > > For details on baselines, refer to Set baselines on a sheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present in dependency-enabled project sheets. It indicates what the duration represents in terms of the dependency-enabled project. - `type` 'DURATION', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column that identifies the user who last modified each row. > **Note:** A sheet has at most, one of these columns. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'MODIFIED_BY', required — If specified, the contact represents the user who created the row or last modified it. - `type` 'CONTACT_LIST', required - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A system-populated column of datetime values representing each row's last modification datetime. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `systemColumnType` 'MODIFIED_DATE', required — The system row modification datetime type. - `type` 'DATETIME', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined contacts from which you can choose multiple for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `contactOptions` ContactOption[] — Array of ContactOption objects to specify a pre-defined list of values for the column. - `email` string — A parsable email address. - `name` string — Can be a user's name, display name, or free text. - `type` 'MULTI_CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 1, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined values from which you can choose multiple for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches a combination of the symbol options exactly, and include new line separators between multiple values. For example: =JOIN(Range1@row:Range3@row, CHAR(10)) **Important:** To match multiple symbol option values, the return string must use a new line separator (that is, `CHAR(10)`) between symbol option values. - `options` string[], required — An array of the options available to use in the column. A cell value in this column can contain any number of these options. - `type` 'MULTI_PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 2, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column tracks each row's progress in terms of percentage complete. - general description > **Important:** This column type is for *dependency-enabled project sheets only*. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. > > For details on baselines, refer to Set baselines on a sheet. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column specifies zero or more rows on which the current row depends. > **Important:** This column type is for *dependency-enabled project sheets only*. > > For details on dependency-enabled projects and Gantt view, refer to Activate dependencies and use predecessors in grid and Gantt view. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] - `type` 'PREDECESSOR', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column provides a predefined list of contacts from which you can choose a task's assigned resource. > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `options` string[], required — An array of contacts available to use in the column. A cell value in this column can contain one contact. - `tags` string[] — This property is only present for dependency-enabled project sheets. - `type` 'CONTACT_LIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column represents a resource assigned to each task (row). > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `primary` boolean — Returned only if the column is the Primary Column (value = **true**). - `tags` string[] — This property is only present for dependency-enabled project sheets. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — This column specifies how much of a person's (or placeholder's) time can be allotted to a project assignment (task). > **Important:** This column type is only for *dependency-enabled project sheets that use Resource Management*. > > For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `tags` string[] — This property is only present for dependency-enabled project sheets. For details on Gantt view, refer to Create and work with a Gantt view. For details on workload tracking and Resource Management, see Workload tracking in Smartsheet. - `type` 'TEXT_NUMBER', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - object — A column of predefined symbols from which you can choose for each cell. - `description` string — Column description. - `format` string — The format descriptor (see [Cell formatting](/api/smartsheet/guides/advanced-topics/cell-formatting)). **Note:** It's only returned if the `include` query string parameter contains `format` and this column has a non-default format applied to it. - `hidden` boolean — If set to `true`, the column is hidden. - `id` number, required — The column's unique identifier. - `index` number, required — The column's position in the sheet. Indexes start at `0`. - `locked` boolean — If set to `true`, the column is locked. Locking a column requires owner or admin permissions on the sheet. - `lockedForUser` boolean — Indicates whether the column is locked for the requesting user. - `title` string, required — Column title. - `width` number, required — The column's display width in pixels. - `formula` string — A formula that returns a string value that matches one of the symbol options exactly (for example, "Red", "Yellow", "Green"). For example: =[Literal Rating]@row - `options` string[], required — An array of the options available to use in the column. **Note:** All applicable `options` values are set automatically when you specify the `symbol`. **Important:** You can't specify or update `options` at the same time you're specifying `symbol`. So leave it unspecified when you're creating a column or updating its `symbol`. If needed, you can update `options` in a separate call. - `symbol` 'FLAG' | 'STAR' | 'HARVEY_BALLS' | 'PRIORITY' | 'RYG' | 'PRIORITY_HML' | 'DECISION_SYMBOLS' | 'DECISION_SHAPES' | 'VCR' | 'RYGB' | 'RYGG' | 'WEATHER' | 'PROGRESS' | 'ARROWS_3_WAY' | 'ARROWS_4_WAY' | 'ARROWS_5_WAY' | 'DIRECTIONS_3_WAY' | 'DIRECTIONS_4_WAY' | 'SKI' | 'SIGNAL' | 'STAR_RATING' | 'HEARTS' | 'MONEY' | 'EFFORT' | 'PAIN' — Specifies any type of symbol the column uses. For details and examples, see [Symbol Columns](/api/smartsheet/openapi/columns). - `type` 'PICKLIST', required — The column's type. See [Column Types](/api/smartsheet/openapi/columns). - `validation` boolean, required — If `true`, validation is enabled for the column values. - `version` 0, required — The column's compatibility level. For details, refer to [Complex data types and compatibility](/api/smartsheet/guides/advanced-topics/complex-column-types-and-compatibility). - `conditionalFormat` string — Describes this row's conditional format. Only returned if the include query string parameter contains format and this row has a conditional format applied. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `discussions` Discussion[] — Discussions on the row. Only returned if the include query string parameter contains discussions. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `id` number — Discussion ID. - `comments` Comment[] — Array of comments in discussion. Only returned if the include query string parameter contains comments. - `attachments` Attachment[] — Array of attachments on comments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `discussionId` number — Discussion ID of discussion that contains comment. - `id` number — Comment ID. - `modifiedAt` union - string, date-time - number - `text` string — Comment body. - `commentAttachments` Attachment[] — Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `commentCount` number — Number of comments in the discussion. - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `lastCommentedAt` union - string, date-time - number - `lastCommentedUser` MiniUser — MiniUser Object - `email` string, email - `name` string - `parentId` number — The ID of the associated row or sheet. - `parentType` 'ROW' | 'SHEET' — Type of parent object. - `readOnly` boolean — Indicates whether the user can modify the discussion. - `title` string — Title automatically created by duplicating the first 100 characters of top-level comment. - `proof` Proof — Object containing zero or more media items, including images, videos, and documents, for review, editing, or approval. - `id` number — Proof ID of the proof version. - `originalId` number — Proof ID of the original proof version. - `name` string — Proof name. This is the same as primary column value. If the primary column value is empty, name is empty. - `type` 'DOCUMENT' | 'IMAGE' | 'MIXED' | 'NONE' | 'VIDEO' — File type for the proof version. - `documentType` string — If `type=DOCUMENT`, then this indicates the type of file, such as PDF. - `proofRequestUrl` string — URL to review a proofing request. - `version` number — The version number of the proof. - `lastUpdatedAt` union - string, date-time - number - `lastUpdatedBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `isCompleted` boolean — Indicates whether the proof is completed. - `attachments` Attachment[] — Array of Attachment objects. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `discussions` Discussion[] — Array of Discussion objects. Only returned if the include query string parameter contains discussions. - `accessLevel` 'ADMIN' | 'COMMENTER' | 'EDITOR' | 'EDITOR_SHARE' | 'OWNER' | 'VIEWER' - `id` number — Discussion ID. - `comments` Comment[] — Array of comments in discussion. Only returned if the include query string parameter contains comments. - `attachments` Attachment[] — Array of attachments on comments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - … - `createdBy` MiniUser — MiniUser Object - … - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `discussionId` number — Discussion ID of discussion that contains comment. - `id` number — Comment ID. - `modifiedAt` union - string, date-time - number - `text` string — Comment body. - `commentAttachments` Attachment[] — Array of attachments on discussion comments. Only returned if the include query string parameter contains attachments. - `id` number — Attachment ID. - `parentId` number — The ID of the parent. - `attachmentType` 'BOX_COM' | 'DROPBOX' | 'EGNYTE' | 'EVERNOTE' | 'FILE' | 'GOOGLE_DRIVE' | 'LINK' | 'ONEDRIVE' | 'TRELLO' — Attachment type. Note--Dropbox, Egnyte, and Evernote are not supported for Smartsheet.gov accounts. - `attachmentSubType` 'DOCUMENT' | 'DRAWING' | 'FOLDER' | 'PDF' | 'PRESENTATION' | 'SPREADSHEET' — Attachment sub type. Note--Folder type is for EGNYTE values and the rest are GOOGLE_DRIVE values. - `mimeType` string — Attachment MIME type. - `parentType` 'COMMENT' | 'PROOF' | 'ROW' | 'SHEET' — The type of object the attachment belongs to. - `createdAt` union - string, date-time - number - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `name` string — Attachment name. - `sizeInKb` number — The size of the file, if the attachmentType is FILE. - `url` string — Attachment temporary URL (files only). - `urlExpiresInMillis` number — Attachment temporary URL time to live (files only). - `commentCount` number — Number of comments in the discussion. - `createdBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `lastCommentedAt` union - string, date-time - number - `lastCommentedUser` MiniUser — MiniUser Object - `email` string, email - `name` string - `parentId` number — The ID of the associated row or sheet. - `parentType` 'ROW' | 'SHEET' — Type of parent object. - `readOnly` boolean — Indicates whether the user can modify the discussion. - `title` string — Title automatically created by duplicating the first 100 characters of top-level comment. - `expanded` boolean — Indicates whether the row is expanded or collapsed. - `filteredOut` boolean — Indicates if the row is filtered out by a column filter. Only returned if the include query string parameter contains filters. - `format` string — Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied. - `inCriticalPath` boolean — Only returned, with a value of true, if the sheet is a project sheet with dependencies enabled and this row is in the critical path. - `locked` boolean — Indicates whether the row is locked. - `lockedForUser` boolean — Indicates whether the row is locked for the requesting user. - `modifiedAt` union - string, date-time - number - `modifiedBy` MiniUser — MiniUser Object - `email` string, email - `name` string - `permaLink` string — URL that represents a direct link to the row in Smartsheet. Only returned if the include query string parameter contains rowPermalink. - `rowNumber` number — Row number within the sheet. - `version` number — Sheet version number that is incremented every time a sheet is modified. --- [API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)