Skip to main content
PATCH
/
v1
/
tables
/
{table_id}
Update Table
curl --request PATCH \
  --url https://api.extruct.ai/v1/tables/{table_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "columns_order": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "columns": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "config": {
        "name": "<string>",
        "key": "<string>",
        "kind": "input"
      }
    }
  ],
  "owner": {
    "id": "<string>",
    "email": "<string>"
  },
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "child_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ],
  "parent_relationships": [
    {
      "table_id": "<string>",
      "relationship_type": "company_people"
    }
  ]
}

​
Overview

This endpoint updates table metadata such as name, description, tags, or column order.

​
Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"
export TABLE_ID="YOUR_TABLE_ID"

curl -X PATCH "https://api.extruct.ai/v1/tables/${TABLE_ID}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  -d '{
    "name": "Company Research v2",
    "description": "Updated enrichment scope"
  }'

​
Key parameters

  • table_id (required): target table identifier.
  • Body fields (all optional): name, description, tags, columns_order.

​
Success signal

A successful response returns the updated table metadata with the same id.

​
Common errors

​
401 Unauthorized

Check that your header is Authorization: Bearer ${EXTRUCT_API_TOKEN}.

​
404 Not Found

The table ID is invalid or unavailable in your workspace.

​
422 Unprocessable Entity

Most often caused by invalid JSON or unsupported field shapes.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
table_id
string
required

Body

application/json
​
name
string | null

New table name to set, if provided.

​
description
string | null

New table description to set, if provided.

​
tags
string[] | null

New table tags to set, if provided.

​
columns_order
string[] | null

New order of column IDs, if provided.

Response

Successful Response

​
id
string
required

Table ID.

​
created_at
string<date-time>
required

Table creation time.

​
name
string
required

Table name.

​
kind
enum<string>
required

Table type.

Available options:
generic,
company,
people
​
columns
ColumnOutputSchema · object[]
required

Table columns configurations.

​
owner
OwnerInfo · object
required
​
description
string | null

Table description.

​
tags
string[] | null

Table tags.

​
child_relationships
TableRelationshipOutput · object[]

Child table relationships.

​
parent_relationships
TableRelationshipOutput · object[]

Parent table relationships.