Skip to main content
PATCH
/
integrations
/
{integration_id}
/
integration-fields
/
{integration_field_id}
TypeScript
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();
{
  "status": "success",
  "data": {
    "id": "9suhxJU83Kon4kPTS47837uE",
    "key": "tax_id",
    "model": "hris_employees",
    "type": "DEFAULT",
    "label": "Tax ID",
    "is_passthrough_enabled": true,
    "is_writable": false
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Path Parameters

​
integration_id
string
required

PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter

​
integration_field_id
string
required

PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter

Body

application/json

PATCH /integrations/:integration_id/integration-fields/:integration_field_id Request body

​
enable_passthrough
boolean | null
required

Response

PATCH /integrations/:integration_id/integration-fields/:integration_field_id Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "id": "9suhxJU83Kon4kPTS47837uE",
  "key": "tax_id",
  "model": "hris_employees",
  "type": "DEFAULT",
  "label": "Tax ID",
  "is_passthrough_enabled": true,
  "is_writable": false
}