Update a tag definition.

PUT

tags

{tagId}

curl --request PUT \
  --url https://{hostname}.gable.ai/v0/tags/{tagId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "detection_enabled": true
}
'

import requests

url = "https://{hostname}.gable.ai/v0/tags/{tagId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "color": "<string>",
    "detection_enabled": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    color: '<string>',
    detection_enabled: true
  })
};

fetch('https://{hostname}.gable.ai/v0/tags/{tagId}', 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://{hostname}.gable.ai/v0/tags/{tagId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>',
    'detection_enabled' => true
  ]),
  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://{hostname}.gable.ai/v0/tags/{tagId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://{hostname}.gable.ai/v0/tags/{tagId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/tags/{tagId}")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}"

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

{
  "tag": {
    "id": "<string>",
    "name": "<string>",
    "kind": "SYSTEM",
    "status": "active",
    "detection_enabled": true,
    "description": "<string>",
    "color": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  }
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

tagId

string

required

The tag definition id, as minted on create.

Body

application/json

Update a tag definition. Every property is optional and an omitted one is left alone. id and kind are not updatable: id is the join key every field tag carries, and kind is the server's classification.

name

string

New display name. The id stays as it was minted and every field keeps its tag, since field tags address the definition by id and resolve the name at read time.

Minimum string length: 1

status

enum<string>

Deactivating hides the tag everywhere — pickers and field tag reads — and refuses new ADDs; the stored labels survive and render again on reactivation. This is what the UI offers in place of deleting a SYSTEM tag.

Available options:

active,

inactive

description

string

color

string

detection_enabled

boolean

Advisory only. The ingest detector always applies pii, gated on nothing but that definition existing, so setting this is accepted and inert.

Response

The updated definition.

A single tag definition, as returned by create and update.

tag

object

required

One tag in the organization's vocabulary. Field tags reference it by id and the read joins it in, so a rename takes effect everywhere at once. readOnly properties are not settable on POST or PUT.

Show child attributes

⌘I

Update a tag definition.

curl --request PUT \
  --url https://{hostname}.gable.ai/v0/tags/{tagId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "detection_enabled": true
}
'

import requests

url = "https://{hostname}.gable.ai/v0/tags/{tagId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "color": "<string>",
    "detection_enabled": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    color: '<string>',
    detection_enabled: true
  })
};

fetch('https://{hostname}.gable.ai/v0/tags/{tagId}', 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://{hostname}.gable.ai/v0/tags/{tagId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>',
    'detection_enabled' => true
  ]),
  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://{hostname}.gable.ai/v0/tags/{tagId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://{hostname}.gable.ai/v0/tags/{tagId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/tags/{tagId}")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"detection_enabled\": true\n}"

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

{
  "tag": {
    "id": "<string>",
    "name": "<string>",
    "kind": "SYSTEM",
    "status": "active",
    "detection_enabled": true,
    "description": "<string>",
    "color": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  }
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Introduction

Gable

Update a tag definition.

Authorizations

Path Parameters

Body

Response