Skip to main content
PUT
/
integrations
/
{integration_id}
/
custom-fields
/
{custom_field_id}
Python
from kombo import SDK


with SDK(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.general.update_custom_field_mapping(integration_id="integration_id", custom_field_id="custom_field_id", integration_field_id="integration_field_id")

    # Handle response
    print(res)
{
  "status": "success",
  "data": {
    "id": "EU3Bwa4iDfGspEELW71WDvvu",
    "key": "tshirt_size",
    "integration_field": {
      "id": "3n6geaAmKL5tFonXVAtsMDmr",
      "key": "custom.tshirt_size",
      "type": "CUSTOM",
      "label": "T-Shirt Size"
    },
    "model": "hris_employees",
    "label": "T-Shirt Size",
    "description": "Map this to the employee's tshirt size"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
integration_id
string
required

The unique ID of the integration where the custom field mapping should be updated

​
custom_field_id
string
required

The unique ID of the custom field that should be updated

Body

application/json

PUT /integrations/:integration_id/custom-fields/:custom_field_id Request body

​
integration_field_id
string | null
required

The integration field's unique ID which the custom field should be mapped to. Null to remove a mapping.

Response

PUT /integrations/:integration_id/custom-fields/:custom_field_id Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "id": "EU3Bwa4iDfGspEELW71WDvvu",
  "key": "tshirt_size",
  "integration_field": {
    "id": "3n6geaAmKL5tFonXVAtsMDmr",
    "key": "custom.tshirt_size",
    "type": "CUSTOM",
    "label": "T-Shirt Size"
  },
  "model": "hris_employees",
  "label": "T-Shirt Size",
  "description": "Map this to the employee's tshirt size"
}