View as Markdown
Smartsheet icon

Smartsheet ACTION

Add Column

Add a single column to an existing sheet, at the end or at a chosen position. Returns the created column under result, including its ID. Use List Columns to see the existing columns and their positions first. To change a column that already exists, use Update Column. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Smartsheet account once, then configure and run Add Column from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "smartsheet-add-column",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    smartsheet: { authProvisionId: "apn_xxxxxxx" },
    sheetId: "Sheet ID or URL",
    title: "Column Title",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Column inputs
Property Type Description
sheetId Sheet ID or URL string
The sheet to act on. Accepts a numeric sheet ID (e.g. 1234567890123456), or a Smartsheet sheet URL, which is resolved to the ID for you. Use List Sheets to enumerate sheets, or Search to find one by name.
Required
title Column Title string
The column title. Must be unique within the sheet.
Required
columnType Column Type string
The data type for this column. PICKLIST and MULTI_PICKLIST accept Picklist Options, but the API also creates them with no options (you can add options later with Update Column). Note that requesting DATETIME creates an ABSTRACT_DATETIME column, since DATETIME is reserved for system columns. Changing a column's type later can lose data.
Required
index Position Index integer
Zero-based position for the new column. If omitted, the column is added at the end. A value past the last column is clamped by the API rather than rejected.
Optional
options Picklist Options string
JSON array of option strings for a PICKLIST or MULTI_PICKLIST column. Optional: the API also creates those columns with no options. Example: ["Low", "Medium", "High", "Critical"]
Optional
validation Validation boolean
Set to true to restrict cell values to the picklist options. PICKLIST and MULTI_PICKLIST only.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
smartsheet-add-column
Version
1.0.1
App
Smartsheet
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes