Update Table Sheet Column

Update a Table sheet column.

PATCH /api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}

Update Column

cURL

curl --request PATCH \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "<string>",
  "config": {},
  "dependencies": [
    {
      "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference_type": "value",
      "config_key": "<string>",
      "config_meta": {}
    }
  ]
}
'

import requests

url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}"

payload = {
    "title": "<string>",
    "config": {},
    "dependencies": [
        {
            "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reference_type": "value",
            "config_key": "<string>",
            "config_meta": {}
        }
    ]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    config: {},
    dependencies: [
      {
        column_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        reference_type: 'value',
        config_key: '<string>',
        config_meta: {}
      }
    ]
  })
};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'config' => [
        
    ],
    'dependencies' => [
        [
                'column_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'reference_type' => 'value',
                'config_key' => '<string>',
                'config_meta' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"config\": {},\n  \"dependencies\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reference_type\": \"value\",\n      \"config_key\": \"<string>\",\n      \"config_meta\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"config\": {},\n  \"dependencies\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reference_type\": \"value\",\n      \"config_key\": \"<string>\",\n      \"config_meta\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/{sheet_id}/columns/{column_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"config\": {},\n  \"dependencies\": [\n    {\n      \"column_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"reference_type\": \"value\",\n      \"config_key\": \"<string>\",\n      \"config_meta\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "column": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sheet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": 123,
    "title": "<string>",
    "config": {},
    "position_rank": 123,
    "is_output_column": true
  },
  "requires_recalculation": true,
  "affected_column_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "version": 123
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

Update a column title, config, or dependencies.

Config or dependency changes may require recalculation. The response includes requires_recalculation and affected_column_ids so you can decide whether to run a recalculation operation.

Authorizations

X-API-KEY · string · header · required

Path Parameters

table_id · string<uuid> · required

sheet_id · string<uuid> · required

column_id · string<uuid> · required

Body

application/json

title · string | null

config · object | null

dependencies · object[] | null

Show child attributes

Response

200

application/json

Column updated

success · boolean

column · object

A column within a Table sheet.

Show child attributes

requires_recalculation · boolean

affected_column_ids · string<uuid>[]

version · integer

Current sheet version_count for this response. It matches the sheet's version_count after any committed changes.