PUT
/
workspace
/
{ws_id}
/
table
/
{table}
/
fields
/
{field}
Update Field for Table
curl --request PUT \
  --url https://app.blinkops.com/api/v1/workspace/{ws_id}/table/{table}/fields/{field} \
  --header 'BLINK-API-KEY: <api-key>' \
  --header 'Content-Type: */*' \
  --data '{
  "attributes": {
    "default_value": "Default",
    "include_time": false,
    "options": [
      "Option 1",
      "Option 2",
      "Option 3"
    ],
    "table_reference": {
      "table_name": "Table 1",
      "display_name_field": "Name"
    }
  },
  "display_name": "Test",
  "type": "single-select"
}'
{
  "attributes": {},
  "created_at": 123,
  "created_by": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "id": "<string>",
  "indexes": {},
  "name": "<string>",
  "table_id": "<string>",
  "tenant_id": "<string>",
  "type": "<string>",
  "updated_at": 123,
  "updated_by": "<string>",
  "workspace_id": "<string>"
}

Authorizations

​
BLINK-API-KEY
string
header
required

Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.

Path Parameters

​
ws_id
string
required

Workspace ID

​
table
string
required

Table Name

​
field
string
required

Field Name

Body

*/*

Updated Field Data

​
attributes
object

Configurable settings for the field.

​
display_name
string

The field's display name. To retain or update the display name, you must explicitly provide its full value in the request.

Example:

"Test"

​
type
enum<string>

The field's type. Changing the type is not allowed, but to preserve the current type, it must be explicitly included in the request.

Available options:
text,
long-text,
number,
risk-level,
checkbox,
single-select,
multi-select,
list,
reference,
date
Example:

"single-select"

Response

OK

​
attributes
object
​
created_at
integer
​
created_by
string
​
description
string
​
display_name
string
​
id
string
​
indexes
object
​
name
string
​
table_id
string
​
tenant_id
string
​
type
string
​
updated_at
integer
​
updated_by
string
​
workspace_id
string