PUT
/
integrations
/
{integration_id}
/
custom-fields
/
{custom_field_id}
curl --request PUT \
  --url https://api.kombo.dev/v1/integrations/{integration_id}/custom-fields/{custom_field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "integration_field_id": "integration_field_id"
}'
{
  "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": "Tsirt Size",
    "description": "Map this to the employee's tshirt size"
  }
}

Authorizations

Authorization
string
headerrequired

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

200 - application/json
status
enum<string>
required
Available options:
success
data
object
required