---
title: "Put custom field mappings"
method: PUT
path: "/integrations/{integration_id}/custom-fields/{custom_field_id}"
tags: ["General"]
---

# Put custom field mappings

`PUT /integrations/{integration_id}/custom-fields/{custom_field_id}`

Updates the mapping of a given custom field. If the custom field is already mapped, it will be updated.

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

## Request body

- PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdRequestBody
  - `integration_field_id` string, nullable, required — The integration field's unique ID which the custom field should be mapped to. Null to remove a mapping.

## Response `200`

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

- PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdPositiveResponse
  - `status` 'success', required
  - `data` object, required
    - `id` string, required — The unique ID of the field
    - `key` string, required — The key of the custom field as it will be used in the custom_field object of the corresponding model
    - `integration_field` object, nullable, required — The integration field the custom field is mapped to. Null if not mapped.
      - `id` string, required — The integration field's unique ID
      - `key` string, required — The key of the integration field in the remote system
      - `type` 'DEFAULT' | 'CUSTOM', required — The type of the integration field. There is a type to avoid collisions between DEFAULT fields and CUSTOM fields with the same key.
      - `label` string, nullable, required — The label of the integration field in the remote system
    - `model` string, required — The model the field is associated with
    - `label` string, nullable, required — The label of the custom field
    - `description` string, nullable, required — The description of the custom field

## Other responses

- `default` — The standard error response with just the platform error codes.

---

[API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/149bf44faf1a/schema)