Updates an integration fields passthrough setting

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)

{
  "status": "success",
  "data": {
    "id": "9suhxJU83Kon4kPTS47837uE",
    "key": "tax_id",
    "model": "hris_employees",
    "type": "DEFAULT",
    "label": "Tax ID",
    "is_passthrough_enabled": true,
    "is_writable": false
  }
}

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)

{
  "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

Show child attributes

data.id

string

required

The unique ID of the field.

data.key

string

required

The key of the field in the remote system.

data.model

string

required

The model the field is associated with.

data.type

enum<string>

required

The type of the integration field. There is a type to avoid collisions between DEFAULT fields and CUSTOM fields with the same key.

Available options:

DEFAULT,

CUSTOM

data.label

string | null

required

The label of the field in the remote system.

data.is_passthrough_enabled

boolean

required

Whether the field is included in the integrations_fields array of the corresponding model.

data.is_writable

boolean

required

This field is related to a deprecated feature and means nothing, but is kept for backwards compatibility.

⌘I

General

Features

Guides

ATS Assessment API Reference

General API Reference

Updates an integration fields passthrough setting

Authorizations

Path Parameters

Body

Response