Update Column

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/column
API call form
Examples

Update an existing column. Only users who have edit access to the dataset to which the column is associated, can update the column. If you're updating a derived column expression, we recommend to first validate the expression against syntax and logical errors using the validate action.

For embed tokens of a tenant, the token's tenant_fields_rights applies to the tenant's own columns and rights applies to all other columns. Updating a derived column assigned only to the caller's tenant requires use ; updating any other column assigned to the caller's tenant requires modify . A discovered field of a tenant dataset source cannot be updated until it is saved: updating it returns 404 .

Request parametersResponse schema
Expand all Reset
id *UUIDrequired

The unique identifier of the entity

properties *OBJECTrequired
name Multilingual string
description Multilingual string
ai_context STRING
order NUMBER
type STRING
subtype STRING
format STRING
informat STRING
color STRING
isLabel BOOLEAN
lowestLevel NUMBER
expression STRING
derivation OBJECT
width NUMBER
colors_enabled BOOLEAN
hierarchy_enabled BOOLEAN
ordering_enabled BOOLEAN
aggregation_type STRING
currency_id STRING
timezone_id STRING
duration_levels ARRAY[INTEGER]
duration_format STRING
custom_metadata OBJECT
Can be executed by:
Securable Modifier
Can be associated to:
Securable
Joins
HierarchyLevels
Currency
Tenants
Did this page help you?
Yes No
Language
Shell
Node
Java
.NET
Python
PHP
Install
npm install @luzmo/nodejs-sdk
Example Request 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.update('column', '<column_id>',
  {
    name: {
      en: "Burrito name"
    }
  }
);
You are not authenticated.
Log in to try
Example Response
200
400
500
{
  "id": "8014daa9-bc79-42ee-b71d-81dc1525a3c8",
  "name": {
    "en": "Purchase id"
  },
  "description": null,
  "ai_context": null,
  "order": 1,
  "source_name": "Purchase id",
  "type": "hierarchy",
  "subtype": null,
  "format": "",
  "informat": "hierarchy",
  "previous_datetime_informat": null,
  "color": "#3182bd",
  "prefix": null,
  "suffix": null,
  "isLabel": false,
  "minBound": null,
  "maxBound": null,
  "cardinality": null,
  "lowestLevel": 0,
  "highestLevel": 0,
  "minimum": null,
  "maximum": null,
  "expression": null,
  "derivation": null,
  "version": 0,
  "width": 170,
  "hierarchy_enabled": false,
  "ordering_enabled": false,
  "colors_enabled": true,
  "aggregation_type": "sum",
  "custom_aggregations": null,
  "custom_metadata": null,
  "duration_levels": null,
  "duration_format": "long",
  "created_at": "2024-01-16T15:21:37.924Z",
  "updated_at": "2024-01-16T15:21:37.924Z",
  "securable_id": "807623f5-ac65-4022-bc87-595b412ce397",
  "aggregation_id": null,
  "currency_id": null
}