v3

OpenAPI 3.1.02026-07-311255771.3 MB

General

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}

Path parameters

integration_idstring required

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

integration_field_idstring required

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

Request body

enable_passthroughboolean nullable required

Response

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

status'success' required

Example response

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