Update Saas Field

curl --request PUT \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_name": "<string>",
  "api_identifier": "<string>",
  "data_type": "<string>",
  "description": "<string>",
  "is_required": true,
  "is_unique": true,
  "skip_embedding": false,
  "semantic_type": "<string>",
  "semantic_type_confidence": 123,
  "sample_values": [
    "<unknown>"
  ],
  "enum_cardinality": 123,
  "null_pct": 123,
  "distinct_pct": 123,
  "last_analyzed": "2023-11-07T05:31:56Z",
  "approx_distinct_count": 123,
  "minhash_signature": [
    123
  ],
  "format_signature": {},
  "length_stats": {},
  "entropy": 123,
  "role": "<string>",
  "role_confidence": 123,
  "is_active": true,
  "description_generated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}"

payload = {
    "field_name": "<string>",
    "api_identifier": "<string>",
    "data_type": "<string>",
    "description": "<string>",
    "is_required": True,
    "is_unique": True,
    "skip_embedding": False,
    "semantic_type": "<string>",
    "semantic_type_confidence": 123,
    "sample_values": ["<unknown>"],
    "enum_cardinality": 123,
    "null_pct": 123,
    "distinct_pct": 123,
    "last_analyzed": "2023-11-07T05:31:56Z",
    "approx_distinct_count": 123,
    "minhash_signature": [123],
    "format_signature": {},
    "length_stats": {},
    "entropy": 123,
    "role": "<string>",
    "role_confidence": 123,
    "is_active": True,
    "description_generated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    field_name: '<string>',
    api_identifier: '<string>',
    data_type: '<string>',
    description: '<string>',
    is_required: true,
    is_unique: true,
    skip_embedding: false,
    semantic_type: '<string>',
    semantic_type_confidence: 123,
    sample_values: ['<unknown>'],
    enum_cardinality: 123,
    null_pct: 123,
    distinct_pct: 123,
    last_analyzed: '2023-11-07T05:31:56Z',
    approx_distinct_count: 123,
    minhash_signature: [123],
    format_signature: {},
    length_stats: {},
    entropy: 123,
    role: '<string>',
    role_confidence: 123,
    is_active: true,
    description_generated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}",
  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([
    'field_name' => '<string>',
    'api_identifier' => '<string>',
    'data_type' => '<string>',
    'description' => '<string>',
    'is_required' => true,
    'is_unique' => true,
    'skip_embedding' => false,
    'semantic_type' => '<string>',
    'semantic_type_confidence' => 123,
    'sample_values' => [
        '<unknown>'
    ],
    'enum_cardinality' => 123,
    'null_pct' => 123,
    'distinct_pct' => 123,
    'last_analyzed' => '2023-11-07T05:31:56Z',
    'approx_distinct_count' => 123,
    'minhash_signature' => [
        123
    ],
    'format_signature' => [
        
    ],
    'length_stats' => [
        
    ],
    'entropy' => 123,
    'role' => '<string>',
    'role_confidence' => 123,
    'is_active' => true,
    'description_generated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}"

	payload := strings.NewReader("{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "saas_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "field_name": "<string>",
  "api_identifier": "<string>",
  "data_type": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "is_required": true,
  "is_unique": true,
  "is_active": true,
  "semantic_type": "<string>",
  "semantic_type_confidence": 123,
  "sample_values": [
    "<unknown>"
  ],
  "enum_cardinality": 123,
  "null_pct": 123,
  "distinct_pct": 123,
  "last_analyzed": "2023-11-07T05:31:56Z",
  "approx_distinct_count": 123,
  "minhash_signature": [
    123
  ],
  "format_signature": {},
  "length_stats": {},
  "entropy": 123,
  "role": "<string>",
  "role_confidence": 123,
  "description_generated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

api

integration-sources

{source_id}

saas-objects

{object_id}

saas-fields

{field_id}

Update Saas Field

curl --request PUT \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_name": "<string>",
  "api_identifier": "<string>",
  "data_type": "<string>",
  "description": "<string>",
  "is_required": true,
  "is_unique": true,
  "skip_embedding": false,
  "semantic_type": "<string>",
  "semantic_type_confidence": 123,
  "sample_values": [
    "<unknown>"
  ],
  "enum_cardinality": 123,
  "null_pct": 123,
  "distinct_pct": 123,
  "last_analyzed": "2023-11-07T05:31:56Z",
  "approx_distinct_count": 123,
  "minhash_signature": [
    123
  ],
  "format_signature": {},
  "length_stats": {},
  "entropy": 123,
  "role": "<string>",
  "role_confidence": 123,
  "is_active": true,
  "description_generated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}"

payload = {
    "field_name": "<string>",
    "api_identifier": "<string>",
    "data_type": "<string>",
    "description": "<string>",
    "is_required": True,
    "is_unique": True,
    "skip_embedding": False,
    "semantic_type": "<string>",
    "semantic_type_confidence": 123,
    "sample_values": ["<unknown>"],
    "enum_cardinality": 123,
    "null_pct": 123,
    "distinct_pct": 123,
    "last_analyzed": "2023-11-07T05:31:56Z",
    "approx_distinct_count": 123,
    "minhash_signature": [123],
    "format_signature": {},
    "length_stats": {},
    "entropy": 123,
    "role": "<string>",
    "role_confidence": 123,
    "is_active": True,
    "description_generated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    field_name: '<string>',
    api_identifier: '<string>',
    data_type: '<string>',
    description: '<string>',
    is_required: true,
    is_unique: true,
    skip_embedding: false,
    semantic_type: '<string>',
    semantic_type_confidence: 123,
    sample_values: ['<unknown>'],
    enum_cardinality: 123,
    null_pct: 123,
    distinct_pct: 123,
    last_analyzed: '2023-11-07T05:31:56Z',
    approx_distinct_count: 123,
    minhash_signature: [123],
    format_signature: {},
    length_stats: {},
    entropy: 123,
    role: '<string>',
    role_confidence: 123,
    is_active: true,
    description_generated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}",
  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([
    'field_name' => '<string>',
    'api_identifier' => '<string>',
    'data_type' => '<string>',
    'description' => '<string>',
    'is_required' => true,
    'is_unique' => true,
    'skip_embedding' => false,
    'semantic_type' => '<string>',
    'semantic_type_confidence' => 123,
    'sample_values' => [
        '<unknown>'
    ],
    'enum_cardinality' => 123,
    'null_pct' => 123,
    'distinct_pct' => 123,
    'last_analyzed' => '2023-11-07T05:31:56Z',
    'approx_distinct_count' => 123,
    'minhash_signature' => [
        123
    ],
    'format_signature' => [
        
    ],
    'length_stats' => [
        
    ],
    'entropy' => 123,
    'role' => '<string>',
    'role_confidence' => 123,
    'is_active' => true,
    'description_generated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}"

	payload := strings.NewReader("{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields/{field_id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"field_name\": \"<string>\",\n  \"api_identifier\": \"<string>\",\n  \"data_type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"is_required\": true,\n  \"is_unique\": true,\n  \"skip_embedding\": false,\n  \"semantic_type\": \"<string>\",\n  \"semantic_type_confidence\": 123,\n  \"sample_values\": [\n    \"<unknown>\"\n  ],\n  \"enum_cardinality\": 123,\n  \"null_pct\": 123,\n  \"distinct_pct\": 123,\n  \"last_analyzed\": \"2023-11-07T05:31:56Z\",\n  \"approx_distinct_count\": 123,\n  \"minhash_signature\": [\n    123\n  ],\n  \"format_signature\": {},\n  \"length_stats\": {},\n  \"entropy\": 123,\n  \"role\": \"<string>\",\n  \"role_confidence\": 123,\n  \"is_active\": true,\n  \"description_generated_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "saas_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "field_name": "<string>",
  "api_identifier": "<string>",
  "data_type": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "is_required": true,
  "is_unique": true,
  "is_active": true,
  "semantic_type": "<string>",
  "semantic_type_confidence": 123,
  "sample_values": [
    "<unknown>"
  ],
  "enum_cardinality": 123,
  "null_pct": 123,
  "distinct_pct": 123,
  "last_analyzed": "2023-11-07T05:31:56Z",
  "approx_distinct_count": 123,
  "minhash_signature": [
    123
  ],
  "format_signature": {},
  "length_stats": {},
  "entropy": 123,
  "role": "<string>",
  "role_confidence": 123,
  "description_generated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id

string<uuid> | null

required

object_id

string<uuid>

required

field_id

string<uuid>

required

Query Parameters

organization_id

string<uuid> | null

resource_id

string<uuid> | null

integration_source_id

string<uuid> | null

data_source_id

string<uuid> | null

context_source_id

string<uuid> | null

job_id

string<uuid> | null

Body

application/json

Model for updating a SaaS field.

field_name

string | null

api_identifier

string | null

data_type

string | null

description

string | null

is_required

boolean | null

is_unique

boolean | null

skip_embedding

boolean

default:false

Skip automatic embedding trigger for bulk operations

semantic_type

string | null

semantic_type_confidence

number | null

sample_values

any[] | null

enum_cardinality

integer | null

null_pct

number | null

distinct_pct

number | null

last_analyzed

string<date-time> | null

approx_distinct_count

integer | null

minhash_signature

integer[] | null

format_signature

Format Signature · object | null

Show child attributes

length_stats

Length Stats · object | null

Show child attributes

entropy

number | null

role

string | null

role_confidence

number | null

is_active

boolean | null

description_source

enum<string> | null

Available options:

ai_generated,

manual_edit,

imported,

information_schema

description_generated_at

string<date-time> | null

Response

Successful Response

Response model for SaaS fields.

saas_object_id

string<uuid>

required

The SaaS object this field belongs to

field_name

string

required

Display name for the SaaS field (e.g., 'Email')

api_identifier

string

required

API identifier for the SaaS field (e.g., 'email')

data_type

string

required

The data type of the field (e.g., 'string', 'number')

string<uuid>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

Optional description of the field

is_required

boolean | null

Whether this field is required

is_unique

boolean | null

Whether this field must be unique

is_active

boolean

default:true

Whether this field is enabled and visible to the analysis agent

semantic_type

string | null

Semantic type of the field (e.g., email, phone, date)

semantic_type_confidence

number | null

Confidence score for the detected semantic type

sample_values

any[] | null

Sample values from the field

enum_cardinality

integer | null

Number of distinct values (for enum-like fields)

null_pct

number | null

Percentage of null values in this field

distinct_pct

number | null

Percentage of distinct values in this field

last_analyzed

string<date-time> | null

When this field was last analyzed for metadata

approx_distinct_count

integer | null

Approximate number of distinct values (HyperLogLog)

minhash_signature

integer[] | null

MinHash signature for estimating Jaccard similarity

format_signature

Format Signature · object | null

Distribution of detected value formats / regex patterns

Show child attributes

length_stats

Length Stats · object | null

Value length statistics (min, mean, p95)

Show child attributes

entropy

number | null

Shannon entropy approximation for value distribution

role

string | null

Inferred field role (e.g., PRIMARY_KEY_CANDIDATE)

role_confidence

number | null

Confidence score for the inferred field role

description_source

enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:

ai_generated,

manual_edit,

imported,

information_schema

description_generated_at

string<date-time> | null

When description was last modified

Organizations

Members & Roles

User Identification

Integration Sources

Databases & Catalog

SaaS Catalog

Relationships & Context

Update Saas Field

Authorizations

Path Parameters

Query Parameters

Body

Response