Python
from kombo import Kombo
with Kombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.general.update_integration_field(integration_id="integration_id", integration_field_id="integration_field_id", enable_passthrough=True)
# Handle response
print(res)import { Kombo } from "@kombo-api/sdk";
const kombo = new Kombo({
api_key: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await kombo.general.updateIntegrationField({
integration_id: "integration_id",
integration_field_id: "integration_field_id",
body: {
enable_passthrough: true,
},
});
console.log(result);
}
run();require 'kombo'
Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
security: Models::Shared::Security.new(
api_key: '<YOUR_BEARER_TOKEN_HERE>'
)
)
res = s.general.update_integration_field(integration_id: 'integration_id', integration_field_id: 'integration_field_id', body: Models::Shared::PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdRequestBody.new(
enable_passthrough: true
))
unless res.patch_integrations_integration_id_integration_fields_integration_field_id_positive_response.nil?
# handle response
endcurl --request PATCH \
--url https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enable_passthrough": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enable_passthrough: true})
};
fetch('https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_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://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_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([
'enable_passthrough' => true
]),
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://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id}"
payload := strings.NewReader("{\n \"enable_passthrough\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enable_passthrough\": true\n}")
.asString();{
"status": "success",
"data": {
"id": "9suhxJU83Kon4kPTS47837uE",
"key": "tax_id",
"model": "hris_employees",
"type": "DEFAULT",
"label": "Tax ID",
"is_passthrough_enabled": true,
"is_writable": false
}
}
Updates an integration fields passthrough setting
When enabled, the integration field will be passed as part of the integration_fields array on the specific model endpoint. Providing false will disable the passthrough for the specified field.
PATCH
/
integrations
/
{integration_id}
/
integration-fields
/
{integration_field_id}
Python
from kombo import Kombo
with Kombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.general.update_integration_field(integration_id="integration_id", integration_field_id="integration_field_id", enable_passthrough=True)
# Handle response
print(res)import { Kombo } from "@kombo-api/sdk";
const kombo = new Kombo({
api_key: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await kombo.general.updateIntegrationField({
integration_id: "integration_id",
integration_field_id: "integration_field_id",
body: {
enable_passthrough: true,
},
});
console.log(result);
}
run();require 'kombo'
Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
security: Models::Shared::Security.new(
api_key: '<YOUR_BEARER_TOKEN_HERE>'
)
)
res = s.general.update_integration_field(integration_id: 'integration_id', integration_field_id: 'integration_field_id', body: Models::Shared::PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdRequestBody.new(
enable_passthrough: true
))
unless res.patch_integrations_integration_id_integration_fields_integration_field_id_positive_response.nil?
# handle response
endcurl --request PATCH \
--url https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enable_passthrough": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enable_passthrough: true})
};
fetch('https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_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://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_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([
'enable_passthrough' => true
]),
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://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id}"
payload := strings.NewReader("{\n \"enable_passthrough\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.kombo.dev/v1/integrations/{integration_id}/integration-fields/{integration_field_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enable_passthrough\": true\n}")
.asString();{
"status": "success",
"data": {
"id": "9suhxJU83Kon4kPTS47837uE",
"key": "tax_id",
"model": "hris_employees",
"type": "DEFAULT",
"label": "Tax ID",
"is_passthrough_enabled": true,
"is_writable": false
}
}
Authorizations
Path Parameters
PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter
PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter
Body
application/json
PATCH /integrations/:integration_id/integration-fields/:integration_field_id Request body
Response
PATCH /integrations/:integration_id/integration-fields/:integration_field_id Positive response
Was this page helpful?
⌘I