Update Column

Update a column by name and return the complete schema. Renames update rows, views, and workflow-group references keyed by column ID. Workflow Table blocks keep their authored filter, order, and data JSON unchanged. Bound blocks still referencing the old name appear in unmigrated; edit them with Apply Workflow Operations to prevent failures on their next run.

OAuth scope: api:write.

PATCH/api/v2/tables/{tableId}/columns

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

tableId*string

Unique table identifier.

Length1 <= length

Request Body

application/json

Workspace scope, current column name, and fields to update.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://www.sim.ai/api/v2/tables/string/columns" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "columnName": "plan",    "updates": {      "name": "subscriptionPlan"    }  }'
{
  "data": {
    "columns": [
      {
        "id": "col_name",
        "name": "name",
        "type": "string",
        "required": true,
        "unique": false
      },
      {
        "id": "col_plan",
        "name": "subscriptionPlan",
        "type": "string",
        "required": false,
        "unique": false
      }
    ],
    "unmigrated": [
      {
        "workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
        "workflowName": "Weekly digest",
        "blockId": "blk_9c1d3f5a7e2b4068a0c2e4f6b8d0f193",
        "blockName": "Query plans",
        "fields": [
          "filter"
        ]
      }
    ]
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "LOCKED",
    "message": "This table is insert-locked: new rows cannot be added.",
    "details": {
      "lock": "insert"
    }
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
PATCHUpdate TablePATCHUpdate Row