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>

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

In: header

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

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"    }  }'
const body = JSON.stringify({  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "columnName": "plan",  "updates": {    "name": "subscriptionPlan"  }})fetch("https://www.sim.ai/api/v2/tables/string/columns", {  method: "PATCH",  headers: {    "Content-Type": "application/json",    "X-API-Key": "YOUR_API_KEY"  },  body})
package mainimport (  "fmt"  "net/http"  "io/ioutil"  "strings")func main() {  url := "https://www.sim.ai/api/v2/tables/string/columns"  body := strings.NewReader(`{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "columnName": "plan",    "updates": {      "name": "subscriptionPlan"    }  }`)  req, _ := http.NewRequest("PATCH", url, body)  req.Header.Add("X-API-Key", "YOUR_API_KEY")  req.Header.Add("Content-Type", "application/json")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}
import requestsurl = "https://www.sim.ai/api/v2/tables/string/columns"body = """{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "columnName": "plan",  "updates": {    "name": "subscriptionPlan"  }}"""response = requests.request("PATCH", url, data = body, headers = {  "Content-Type": "application/json",   "X-API-Key": "YOUR_API_KEY"})print(response.text)
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "columnName": "plan",  "updates": {    "name": "subscriptionPlan"  }}""");HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://www.sim.ai/api/v2/tables/string/columns"))  .header("X-API-Key", "YOUR_API_KEY")  .header("Content-Type", "application/json")  .PATCH(body)  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}
using System;using System.Net.Http;using System.Text;var body = new StringContent("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "columnName": "plan",  "updates": {    "name": "subscriptionPlan"  }}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PatchAsync("https://www.sim.ai/api/v2/tables/string/columns", body);var responseBody = await response.Content.ReadAsStringAsync();
{
  "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": "A table lock prevents this operation.",
    "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"
  }
}

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

PATCHUpdate tablePATCHUpdate row