PATCH
/
integrations
/
{integration_id}
/
integration-fields
/
{integration_field_id}
Updates an integration fields passthrough setting
curl --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
}'
{
  "status": "success",
  "data": {
    "id": "9suhxJU83Kon4kPTS47837uE",
    "key": "tax_id",
    "model": "hris_employees",
    "type": "DEFAULT",
    "label": "Tax ID",
    "is_passthrough_enabled": true,
    "is_writable": true
  }
}

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
Examples:
{
  "id": "9suhxJU83Kon4kPTS47837uE",
  "key": "tax_id",
  "model": "hris_employees",
  "type": "DEFAULT",
  "label": "Tax ID",
  "is_passthrough_enabled": true,
  "is_writable": true
}