> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.datagol.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Column

> ## 1️⃣ Overview

**Purpose:**  
Updates an existing column's metadata and configuration within a specified table in a workspace.

This endpoint supports:

- Updating column display name

- Changing UI data type

- Updating UI metadata (title, precision, etc.)

- Modifying column options

---

## 2️⃣ Endpoint

```
PUT /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId}

 `````

---

## 3️⃣ Path Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| workspaceId | UUID | ✅ Yes | Workspace identifier |
| workbookId | UUID | ✅ Yes | Table identifier |
| columnId | UUID | ✅ Yes | Column identifier |

---

## 4️⃣ Authentication

Requires **Bearer JWT Token**

```
Authorization: Bearer <token>

 ```

---

## 5️⃣ Request Headers

| Header | Required |
| --- | --- |
| Authorization | ✅ Yes |
| Content-Type: application/json | ✅ Yes |

---

## 6️⃣ Request Body Schema

``` json
{
  "id": "uuid",
  "name": "string",
  "uiDataType": "string",
  "colOptions": {},
  "uiMetadata": {
    "title": "string",
    "precision": null
  }
}

 ```

---

## 7️⃣ Field Descriptions

### Column Configuration

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| id | UUID | ✅ Yes | Unique identifier of the column to update |
| name | string | ✅ Yes | Internal column name |
| uiDataType | string | ✅ Yes | Column type (e.g., SINGLE_LINE_TEXT, NUMBER, DATE) |
| uiMetadata | object | ✅ Yes | Metadata for UI display |
| uiMetadata.title | string | ✅ Yes | Display name shown in the UI |
|
---

## 8️⃣ Example Request

``` bash
curl -X PUT https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId} \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "id": "6d9ae325-6fcd-4bd6-a732-b59e424fc095",
  "name": "question",
  "uiDataType": "SINGLE_LINE_TEXT",
  "colOptions": {},
  "uiMetadata": {
    "title": "Question",
    "precision": null
  }
}'

 ```

---

## 9️⃣ Behavior Summary

``` id="behcol3"
Updates an existing column's metadata and configuration.
Supports:
• Updating internal column name  
• Changing UI data type  
• Updating display title via uiMetadata  
• Setting precision for numeric columns  
• Passing additional column options via colOptions  
• Server-side validation before update  

 ```



## OpenAPI

````yaml /openapi/openapi.yaml put /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId}
openapi: 3.0.0
info:
  title: DataGOL APIs
  version: 1.0.0
  description: ''
servers:
  - url: https://be.datagol.ai
  - url: https://be.datagol.ai
  - url: https://kg.datagol.ai
  - url: https://ai.datagol.ai
security: []
tags:
  - name: Links & Joins
    description: >
      ## 🔗 Links & Joins


      LINK and LOOKUP are special workbook column types that enable relational
      data modeling across tables.


      | Column Type | Purpose |

      |---|---|

      | `LINK` | Defines a relationship between two tables |

      | `LOOKUP` | Projects columns from an associated table via a link |


      Both are configured through `ColumnDTO.colOptions`. A table can have
      multiple link columns, and each link can have multiple lookup columns.


      ---


      ## 📐 UI Data Types


      - **LINK** — Special column used to represent inter-table relations

      - **LOOKUP** — Special column used to project associated table fields via
      a link


      ---


      ## 🔗 LINK Semantics


      A LINK column stores metadata for:

      - `tableId` — Current table

      - `associatedTableId` — Associated (linked) table

      - `relationType` — Type of relationship

      - `linkColumnId` — Link column identifier


      **Supported relation patterns:**


      | Pattern | Description |

      |---|---|

      | `ONE_TO_ONE` | Each record in the source maps to one record in the
      destination |

      | `ONE_TO_MANY` | One source record maps to many destination records |

      | `MANY_TO_MANY` | Many source records map to many destination records |


      ---


      ## 🔍 LOOKUP Semantics


      - A LOOKUP column is tightly coupled with a specific LINK column

      - References a link using `linkColumnId`

      - Represents a selected column from the associated table

      - Multiple lookup columns can be defined for the same link


      ---


      ## 🗂️ Metadata in `ColumnDTO.colOptions`


      Use `colOptions` to persist link/lookup metadata.


      | Field | Description |

      |---|---|

      | `columnId` | Current column ID |

      | `tableId` | Current table ID |

      | `associatedTableId` | Associated table ID |

      | `linkColumnId` | Link column ID — used by LOOKUP; references the LINK
      column's `columnId` |

      | `relationType` | Relation semantics for LINK |


      ---


      ## 🔄 Manual Linking Record Flow


      To create manual record-level links:


      1. Fetch associated table schema/data

      2. User selects associated record(s) to link

      3. Send linking payload with:
          - `sourceRecordId` — PK of the current table row
          - `destinationRecordId` — PK of the associated table row
          - `linkColumnId` — LINK column identifier
      4. Backend resolves link metadata from `linkColumnId` (relation type,
      associated table, direction/constraints)

      5. Backend applies relation rules and stores the link relation


      ---


      ## 📋 Record Linking Contract


      | Field | Description |

      |---|---|

      | `sourceRecordId` | PK of the current table row |

      | `destinationRecordId` | PK of the associated table row |

      | `linkColumnId` | LINK column identifier |

      | `tableId` | Current table ID |


      > Backend derives all remaining relation metadata from the link
      configuration.


      ---


      ## ⚠️ Important Notes


      > - LINK and LOOKUP are **column-level constructs** first; record linking
      is a data-level operation built on top

      > - LOOKUP behavior depends on LINK existence and metadata integrity

      > - With multiple links to the same associated table, each LOOKUP must
      bind to the correct `linkColumnId`

      > - Always treat the associated row ID as the associated table PK for
      linking UI selection
paths:
  /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId}:
    parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
        example: '{{workspaceId}}'
      - name: workbookId
        in: path
        required: true
        schema:
          type: string
        example: '{{workbookId}}'
      - name: columnId
        in: path
        required: true
        schema:
          type: string
        example: '{{columnId}}'
    put:
      tags:
        - WorkBook
      summary: Update Column
      description: >-
        ## 1️⃣ Overview


        **Purpose:**  

        Updates an existing column's metadata and configuration within a
        specified table in a workspace.


        This endpoint supports:


        - Updating column display name


        - Changing UI data type


        - Updating UI metadata (title, precision, etc.)


        - Modifying column options


        ---


        ## 2️⃣ Endpoint


        ```

        PUT
        /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId}

         `````

        ---


        ## 3️⃣ Path Parameters


        | Parameter | Type | Required | Description |

        | --- | --- | --- | --- |

        | workspaceId | UUID | ✅ Yes | Workspace identifier |

        | workbookId | UUID | ✅ Yes | Table identifier |

        | columnId | UUID | ✅ Yes | Column identifier |


        ---


        ## 4️⃣ Authentication


        Requires **Bearer JWT Token**


        ```

        Authorization: Bearer <token>

         ```

        ---


        ## 5️⃣ Request Headers


        | Header | Required |

        | --- | --- |

        | Authorization | ✅ Yes |

        | Content-Type: application/json | ✅ Yes |


        ---


        ## 6️⃣ Request Body Schema


        ``` json

        {
          "id": "uuid",
          "name": "string",
          "uiDataType": "string",
          "colOptions": {},
          "uiMetadata": {
            "title": "string",
            "precision": null
          }
        }

         ```

        ---


        ## 7️⃣ Field Descriptions


        ### Column Configuration


        | Field | Type | Required | Description |

        | --- | --- | --- | --- |

        | id | UUID | ✅ Yes | Unique identifier of the column to update |

        | name | string | ✅ Yes | Internal column name |

        | uiDataType | string | ✅ Yes | Column type (e.g., SINGLE_LINE_TEXT,
        NUMBER, DATE) |

        | uiMetadata | object | ✅ Yes | Metadata for UI display |

        | uiMetadata.title | string | ✅ Yes | Display name shown in the UI |

        |

        ---


        ## 8️⃣ Example Request


        ``` bash

        curl -X PUT
        https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/columns/{columnId}
        \

        -H "Authorization: Bearer <token>" \

        -H "Content-Type: application/json" \

        -d '{
          "id": "6d9ae325-6fcd-4bd6-a732-b59e424fc095",
          "name": "question",
          "uiDataType": "SINGLE_LINE_TEXT",
          "colOptions": {},
          "uiMetadata": {
            "title": "Question",
            "precision": null
          }
        }'

         ```

        ---


        ## 9️⃣ Behavior Summary


        ``` id="behcol3"

        Updates an existing column's metadata and configuration.

        Supports:

        • Updating internal column name  

        • Changing UI data type  

        • Updating display title via uiMetadata  

        • Setting precision for numeric columns  

        • Passing additional column options via colOptions  

        • Server-side validation before update  

         ```
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - id
                - name
                - uiDataType
                - uiMetadata
              properties:
                id:
                  type: string
                name:
                  type: string
                uiDataType:
                  type: string
                colOptions:
                  type: object
                uiMetadata:
                  type: object
                  properties:
                    title:
                      type: string
                    precision:
                      nullable: true
                      type: number
            example:
              id: 6d9ae325-6fcd-4bd6-a732-b59e424fc095
              name: question
              uiDataType: SINGLE_LINE_TEXT
              colOptions: {}
              uiMetadata:
                title: Question
                precision: null
      responses:
        '200':
          description: Column Updated successfully
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        This API uses OAuth 2.0 with the authorization code grant flow.

````